home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sgbrfs.z / sgbrfs
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          SSSSGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGBRFS - improve the computed solution to a system of linear equations
  10.      when the coefficient matrix is banded, and provides error bounds and
  11.      backward error estimates for the solution
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SGBRFS( TRANS, N, KL, KU, NRHS, AB, LDAB, AFB, LDAFB, IPIV, B,
  15.                         LDB, X, LDX, FERR, BERR, WORK, IWORK, INFO )
  16.  
  17.          CHARACTER      TRANS
  18.  
  19.          INTEGER        INFO, KL, KU, LDAB, LDAFB, LDB, LDX, N, NRHS
  20.  
  21.          INTEGER        IPIV( * ), IWORK( * )
  22.  
  23.          REAL           AB( LDAB, * ), AFB( LDAFB, * ), B( LDB, * ), BERR( *
  24.                         ), FERR( * ), WORK( * ), X( LDX, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      SGBRFS improves the computed solution to a system of linear equations
  41.      when the coefficient matrix is banded, and provides error bounds and
  42.      backward error estimates for the solution.
  43.  
  44. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  45.      TRANS   (input) CHARACTER*1
  46.              Specifies the form of the system of equations:
  47.              = 'N':  A * X = B     (No transpose)
  48.              = 'T':  A**T * X = B  (Transpose)
  49.              = 'C':  A**H * X = B  (Conjugate transpose = Transpose)
  50.  
  51.      N       (input) INTEGER
  52.              The order of the matrix A.  N >= 0.
  53.  
  54.      KL      (input) INTEGER
  55.              The number of subdiagonals within the band of A.  KL >= 0.
  56.  
  57.      KU      (input) INTEGER
  58.              The number of superdiagonals within the band of A.  KU >= 0.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          SSSSGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      NRHS    (input) INTEGER
  75.              The number of right hand sides, i.e., the number of columns of
  76.              the matrices B and X.  NRHS >= 0.
  77.  
  78.      AB      (input) REAL array, dimension (LDAB,N)
  79.              The original band matrix A, stored in rows 1 to KL+KU+1.  The j-
  80.              th column of A is stored in the j-th column of the array AB as
  81.              follows:  AB(ku+1+i-j,j) = A(i,j) for max(1,j-
  82.              ku)<=i<=min(n,j+kl).
  83.  
  84.      LDAB    (input) INTEGER
  85.              The leading dimension of the array AB.  LDAB >= KL+KU+1.
  86.  
  87.      AFB     (input) REAL array, dimension (LDAFB,N)
  88.              Details of the LU factorization of the band matrix A, as computed
  89.              by SGBTRF.  U is stored as an upper triangular band matrix with
  90.              KL+KU superdiagonals in rows 1 to KL+KU+1, and the multipliers
  91.              used during the factorization are stored in rows KL+KU+2 to
  92.              2*KL+KU+1.
  93.  
  94.      LDAFB   (input) INTEGER
  95.              The leading dimension of the array AFB.  LDAFB >= 2*KL*KU+1.
  96.  
  97.      IPIV    (input) INTEGER array, dimension (N)
  98.              The pivot indices from SGBTRF; for 1<=i<=N, row i of the matrix
  99.              was interchanged with row IPIV(i).
  100.  
  101.      B       (input) REAL array, dimension (LDB,NRHS)
  102.              The right hand side matrix B.
  103.  
  104.      LDB     (input) INTEGER
  105.              The leading dimension of the array B.  LDB >= max(1,N).
  106.  
  107.      X       (input/output) REAL array, dimension (LDX,NRHS)
  108.              On entry, the solution matrix X, as computed by SGBTRS.  On exit,
  109.              the improved solution matrix X.
  110.  
  111.      LDX     (input) INTEGER
  112.              The leading dimension of the array X.  LDX >= max(1,N).
  113.  
  114.      FERR    (output) REAL array, dimension (NRHS)
  115.              The estimated forward error bound for each solution vector X(j)
  116.              (the j-th column of the solution matrix X).  If XTRUE is the true
  117.              solution corresponding to X(j), FERR(j) is an estimated upper
  118.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  119.              divided by the magnitude of the largest element in X(j).  The
  120.              estimate is as reliable as the estimate for RCOND, and is almost
  121.              always a slight overestimate of the true error.
  122.  
  123.      BERR    (output) REAL array, dimension (NRHS)
  124.              The componentwise relative backward error of each solution vector
  125.              X(j) (i.e., the smallest relative change in any element of A or B
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          SSSSGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              that makes X(j) an exact solution).
  141.  
  142.      WORK    (workspace) REAL array, dimension (3*N)
  143.  
  144.      IWORK   (workspace) INTEGER array, dimension (N)
  145.  
  146.      INFO    (output) INTEGER
  147.              = 0:  successful exit
  148.              < 0:  if INFO = -i, the i-th argument had an illegal value
  149.  
  150. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  151.      ITMAX is the maximum number of steps of iterative refinement.
  152.  
  153. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  154.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  155.  
  156.      This man page is available only online.
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.